RIVO-Noord Zorgviewer Implementation Guide
1.7.0 - sprint45
RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v1.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/ToestemmingConsent | Version: 1.7.0 | |||
Active as of 2024-11-12 | Computable Name: ToestemmingConsent |
De registatie (Consent) dat de patient de RIVO-Noord policy voor toestemming van gegevensuitwisseling heeft geaccepteerd
Opvragen (search) toestemmingen voor een patient
GET <toestemming-base>/Consent?patient:Patient.identifier=<BSN>
N.B. Bij geen resultaat heeft de patient expliciet geen toestemming gegeven of nog niet toestemming gegeven.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 0..* | Consent | A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time | |
status | S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error |
category | ||||
coding | ||||
code | S | 0..1 | code | Symbol in syntax defined by the system Fixed Value: Doss. delen? |
patient | S | 1..1 | Reference(Patient) | Who the consent applies to |
period | S | 0..1 | Period | Period that this consent applies |
organization | S | 0..* | Reference(Organization) | Custodian of the consent |
policy | S | 0..* | BackboneElement | Policies covered by this consent |
uri | S | 0..1 | uri | Specific policy covered by this consent Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | C | 0..* | Consent | A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent |
category | Σ | 0..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
code | SΣ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: Doss. delen? |
patient | SΣ | 1..1 | Reference(Patient) | Who the consent applies to |
period | SΣ | 0..1 | Period | Period that this consent applies |
organization | SΣ | 0..* | Reference(Organization) | Custodian of the consent |
policy | S | 0..* | BackboneElement | Policies covered by this consent |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
uri | SC | 0..1 | uri | Specific policy covered by this consent Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes from the FHIR Standard | |
Consent.category | example | Consent Category Codeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Consent | C | 0..* | Consent | A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..1 | Identifier | Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"} | ||||
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent | ||||
category | Σ | 0..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: Doss. delen? | ||||
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 | SΣ | 1..1 | Reference(Patient) | Who the consent applies to | ||||
period | SΣ | 0..1 | Period | Period that this consent applies | ||||
dateTime | Σ | 0..1 | dateTime | When this Consent was created or indexed | ||||
consentingParty | Σ | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson) | Who is agreeing to the policy and exceptions | ||||
actor | Σ | 0..* | BackboneElement | Who|what controlled by this consent (or group, by role) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations | |||||
reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson) | Resource for the actor (or group, by role) | |||||
action | Σ | 0..* | CodeableConcept | Actions controlled by this consent Binding: Consent Action Codes (example): Detailed codes for the consent action. | ||||
organization | SΣ | 0..* | Reference(Organization) | Custodian of the consent | ||||
source[x] | Σ | 0..1 | Source from which this consent is taken | |||||
sourceAttachment | Attachment | |||||||
sourceIdentifier | Identifier | |||||||
sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
policy | S | 0..* | BackboneElement | Policies covered by this consent | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
authority | C | 0..1 | uri | Enforcement source for policy | ||||
uri | SC | 0..1 | uri | Specific policy covered by this consent Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming | ||||
policyRule | ΣC | 0..1 | uri | Policy that this consents to | ||||
securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
purpose | Σ | 0..* | Coding | Context of activities for which the agreement is made Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels | ||||
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this consent | ||||
data | Σ | 0..* | BackboneElement | Data controlled by this consent | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions | ||||
reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
except | Σ | 0..* | BackboneElement | Additional rule - addition or removal of permissions | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
type | Σ | 1..1 | code | deny | permit Binding: ConsentExceptType (required): How an exception statement is applied, such as adding additional consent or removing consent | ||||
period | Σ | 0..1 | Period | Timeframe for this exception | ||||
actor | Σ | 0..* | BackboneElement | Who|what controlled by this exception (or group, by role) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations | |||||
reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson) | Resource for the actor (or group, by role) | |||||
action | Σ | 0..* | CodeableConcept | Actions controlled by this exception Binding: Consent Action Codes (example): Detailed codes for the consent action. | ||||
securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
purpose | Σ | 0..* | Coding | Context of activities covered by this exception Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels | ||||
class | Σ | 0..* | Coding | e.g. Resource Type, Profile, or CDA etc Binding: Consent Content Class (extensible): The class (type) of information a consent rule covers | ||||
code | Σ | 0..* | Coding | e.g. LOINC or SNOMED CT code, etc in the content Binding: Consent Content Codes (example): If this code is found in an instance, then the exception applies | ||||
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this exception | ||||
data | Σ | 0..* | BackboneElement | Data controlled by this exception | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions | ||||
reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Consent.language | extensible | Common Languages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes from the FHIR Standard | ||||
Consent.category | example | Consent Category Codeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.action | example | Consent Action Codeshttp://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | ||||
Consent.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Consent.purpose | extensible | PurposeOfUsehttp://hl7.org/fhir/ValueSet/v3-PurposeOfUse from the FHIR Standard | ||||
Consent.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning from the FHIR Standard | ||||
Consent.except.type | required | ConsentExceptTypehttp://hl7.org/fhir/ValueSet/consent-except-type from the FHIR Standard | ||||
Consent.except.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.except.action | example | Consent Action Codeshttp://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | ||||
Consent.except.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Consent.except.purpose | extensible | PurposeOfUsehttp://hl7.org/fhir/ValueSet/v3-PurposeOfUse from the FHIR Standard | ||||
Consent.except.class | extensible | Consent Content Classhttp://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard | ||||
Consent.except.code | example | Consent Content Codes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard | ||||
Consent.except.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() |
This structure is derived from Consent
Differential View
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 0..* | Consent | A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time | |
status | S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error |
category | ||||
coding | ||||
code | S | 0..1 | code | Symbol in syntax defined by the system Fixed Value: Doss. delen? |
patient | S | 1..1 | Reference(Patient) | Who the consent applies to |
period | S | 0..1 | Period | Period that this consent applies |
organization | S | 0..* | Reference(Organization) | Custodian of the consent |
policy | S | 0..* | BackboneElement | Policies covered by this consent |
uri | S | 0..1 | uri | Specific policy covered by this consent Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | C | 0..* | Consent | A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent |
category | Σ | 0..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
code | SΣ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: Doss. delen? |
patient | SΣ | 1..1 | Reference(Patient) | Who the consent applies to |
period | SΣ | 0..1 | Period | Period that this consent applies |
organization | SΣ | 0..* | Reference(Organization) | Custodian of the consent |
policy | S | 0..* | BackboneElement | Policies covered by this consent |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
uri | SC | 0..1 | uri | Specific policy covered by this consent Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes from the FHIR Standard | |
Consent.category | example | Consent Category Codeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Consent | C | 0..* | Consent | A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..1 | Identifier | Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"} | ||||
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent | ||||
category | Σ | 0..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: Doss. delen? | ||||
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 | SΣ | 1..1 | Reference(Patient) | Who the consent applies to | ||||
period | SΣ | 0..1 | Period | Period that this consent applies | ||||
dateTime | Σ | 0..1 | dateTime | When this Consent was created or indexed | ||||
consentingParty | Σ | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson) | Who is agreeing to the policy and exceptions | ||||
actor | Σ | 0..* | BackboneElement | Who|what controlled by this consent (or group, by role) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations | |||||
reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson) | Resource for the actor (or group, by role) | |||||
action | Σ | 0..* | CodeableConcept | Actions controlled by this consent Binding: Consent Action Codes (example): Detailed codes for the consent action. | ||||
organization | SΣ | 0..* | Reference(Organization) | Custodian of the consent | ||||
source[x] | Σ | 0..1 | Source from which this consent is taken | |||||
sourceAttachment | Attachment | |||||||
sourceIdentifier | Identifier | |||||||
sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
policy | S | 0..* | BackboneElement | Policies covered by this consent | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
authority | C | 0..1 | uri | Enforcement source for policy | ||||
uri | SC | 0..1 | uri | Specific policy covered by this consent Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming | ||||
policyRule | ΣC | 0..1 | uri | Policy that this consents to | ||||
securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
purpose | Σ | 0..* | Coding | Context of activities for which the agreement is made Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels | ||||
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this consent | ||||
data | Σ | 0..* | BackboneElement | Data controlled by this consent | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions | ||||
reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
except | Σ | 0..* | BackboneElement | Additional rule - addition or removal of permissions | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
type | Σ | 1..1 | code | deny | permit Binding: ConsentExceptType (required): How an exception statement is applied, such as adding additional consent or removing consent | ||||
period | Σ | 0..1 | Period | Timeframe for this exception | ||||
actor | Σ | 0..* | BackboneElement | Who|what controlled by this exception (or group, by role) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations | |||||
reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson) | Resource for the actor (or group, by role) | |||||
action | Σ | 0..* | CodeableConcept | Actions controlled by this exception Binding: Consent Action Codes (example): Detailed codes for the consent action. | ||||
securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
purpose | Σ | 0..* | Coding | Context of activities covered by this exception Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels | ||||
class | Σ | 0..* | Coding | e.g. Resource Type, Profile, or CDA etc Binding: Consent Content Class (extensible): The class (type) of information a consent rule covers | ||||
code | Σ | 0..* | Coding | e.g. LOINC or SNOMED CT code, etc in the content Binding: Consent Content Codes (example): If this code is found in an instance, then the exception applies | ||||
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this exception | ||||
data | Σ | 0..* | BackboneElement | Data controlled by this exception | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions | ||||
reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Consent.language | extensible | Common Languages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes from the FHIR Standard | ||||
Consent.category | example | Consent Category Codeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.action | example | Consent Action Codeshttp://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | ||||
Consent.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Consent.purpose | extensible | PurposeOfUsehttp://hl7.org/fhir/ValueSet/v3-PurposeOfUse from the FHIR Standard | ||||
Consent.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning from the FHIR Standard | ||||
Consent.except.type | required | ConsentExceptTypehttp://hl7.org/fhir/ValueSet/consent-except-type from the FHIR Standard | ||||
Consent.except.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.except.action | example | Consent Action Codeshttp://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | ||||
Consent.except.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Consent.except.purpose | extensible | PurposeOfUsehttp://hl7.org/fhir/ValueSet/v3-PurposeOfUse from the FHIR Standard | ||||
Consent.except.class | extensible | Consent Content Classhttp://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard | ||||
Consent.except.code | example | Consent Content Codes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard | ||||
Consent.except.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() |
This structure is derived from Consent
Other representations of profile: CSV, Excel, Schematron