The update operation on Consent only accepts changes to the patient, category, data.reference, actor, status, and period contents.
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-consent
This profile builds on Consent.
This profile was published on Fri Jun 07 11:10:06 UTC 2019 as a draft by ehealth.sundhed.dk.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Consent
Summary
Mandatory: 6 elements
Structures
This structure refers to these other structures:
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 0..* | Used to express a Consent regarding Healthcare. | ||
category | 1..* | CodeableConcept | Type of the consent statement Binding: ConsentCategory (required) | |
coding | 0..* | Coding | Binding: ConsentCategory (required) | |
patient | 1..1 | Reference(eHealth Patient) {r} | ||
period | 1..1 | Period | ||
start | 1..1 | dateTime | ||
consentingParty | 1..* | Reference(eHealth Organization | eHealth Patient | eHealth Practitioner | eHealth RelatedPerson) {r} | ||
actor | 1..* | BackboneElement | ||
reference | 1..1 | Reference(eHealth Device | Group | eHealth CareTeam | eHealth Organization | eHealth Patient | eHealth Practitioner | eHealth RelatedPerson) {r} | ||
organization | 0..* | Reference(eHealth Organization) {r} | ||
source[x] | 0..1 | Attachment, Identifier, Reference(eHealth Consent | ehealth-documentreference | Contract | eHealth QuestionnaireResponse) {r} | ||
data | 1..* | BackboneElement | ||
reference | 1..1 | Reference(eHealth EpisodeOfCare) {r} | ||
Documentation for this format |
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | I | 0..* | Used to express a Consent regarding Healthcare. | |
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) | |
text | I | 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 | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required) |
category | Σ | 1..* | CodeableConcept | Type of the consent statement Binding: ConsentCategory (required) |
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 Binding: ConsentCategory (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
patient | Σ | 1..1 | Reference(eHealth Patient) {r} | Who the consent applies to |
period | Σ | 1..1 | Period | Period that this consent applies |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
start | ΣI | 1..1 | dateTime | Starting time with inclusive boundary |
end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
dateTime | Σ | 0..1 | dateTime | When this Consent was created or indexed |
consentingParty | Σ | 1..* | Reference(eHealth Organization | eHealth Patient | eHealth Practitioner | eHealth RelatedPerson) {r} | Who is agreeing to the policy and exceptions |
actor | ΣI | 1..* | 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) | |
reference | 1..1 | Reference(eHealth Device | Group | eHealth CareTeam | eHealth Organization | eHealth Patient | eHealth Practitioner | eHealth RelatedPerson) {r} | Resource for the actor (or group, by role) | |
action | Σ | 0..* | CodeableConcept | Actions controlled by this consent Binding: Consent Action Codes (example) |
organization | Σ | 0..* | Reference(eHealth Organization) {r} | Custodian of the consent |
source[x] | Σ | 0..1 | Attachment, Identifier, Reference(eHealth Consent | ehealth-documentreference | Contract | eHealth QuestionnaireResponse) {r} | Source from which this consent is taken |
policy | I | 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 | I | 0..1 | uri | Enforcement source for policy |
uri | I | 0..1 | uri | Specific policy covered by this consent |
policyRule | ΣI | 0..1 | uri | Policy that this consents to |
securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible) |
purpose | Σ | 0..* | Coding | Context of activities for which the agreement is made Binding: PurposeOfUse (extensible) |
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this consent |
data | ΣI | 1..* | 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) |
reference | Σ | 1..1 | Reference(eHealth EpisodeOfCare) {r} | The actual data reference |
except | ΣI | 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) |
period | Σ | 0..1 | Period | Timeframe for this exception |
actor | ΣI | 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) | |
reference | 1..1 | Reference(eHealth Device | Group | eHealth CareTeam | eHealth Organization | eHealth Patient | eHealth Practitioner | eHealth RelatedPerson) {r} | Resource for the actor (or group, by role) | |
action | Σ | 0..* | CodeableConcept | Actions controlled by this exception Binding: Consent Action Codes (example) |
securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible) |
purpose | Σ | 0..* | Coding | Context of activities covered by this exception Binding: PurposeOfUse (extensible) |
class | Σ | 0..* | Coding | e.g. Resource Type, Profile, or CDA etc Binding: Consent Content Class (extensible) |
code | Σ | 0..* | Coding | e.g. LOINC or SNOMED CT code, etc in the content Binding: Consent Content Codes (example) |
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this exception |
data | ΣI | 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) |
reference | Σ | 1..1 | Reference(Resource) {r} | The actual data reference |
Documentation for this format |
This structure is derived from Consent
Summary
Mandatory: 6 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 0..* | Used to express a Consent regarding Healthcare. | ||
category | 1..* | CodeableConcept | Type of the consent statement Binding: ConsentCategory (required) | |
coding | 0..* | Coding | Binding: ConsentCategory (required) | |
patient | 1..1 | Reference(eHealth Patient) {r} | ||
period | 1..1 | Period | ||
start | 1..1 | dateTime | ||
consentingParty | 1..* | Reference(eHealth Organization | eHealth Patient | eHealth Practitioner | eHealth RelatedPerson) {r} | ||
actor | 1..* | BackboneElement | ||
reference | 1..1 | Reference(eHealth Device | Group | eHealth CareTeam | eHealth Organization | eHealth Patient | eHealth Practitioner | eHealth RelatedPerson) {r} | ||
organization | 0..* | Reference(eHealth Organization) {r} | ||
source[x] | 0..1 | Attachment, Identifier, Reference(eHealth Consent | ehealth-documentreference | Contract | eHealth QuestionnaireResponse) {r} | ||
data | 1..* | BackboneElement | ||
reference | 1..1 | Reference(eHealth EpisodeOfCare) {r} | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | I | 0..* | Used to express a Consent regarding Healthcare. | |
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) | |
text | I | 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 | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required) |
category | Σ | 1..* | CodeableConcept | Type of the consent statement Binding: ConsentCategory (required) |
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 Binding: ConsentCategory (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
patient | Σ | 1..1 | Reference(eHealth Patient) {r} | Who the consent applies to |
period | Σ | 1..1 | Period | Period that this consent applies |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
start | ΣI | 1..1 | dateTime | Starting time with inclusive boundary |
end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
dateTime | Σ | 0..1 | dateTime | When this Consent was created or indexed |
consentingParty | Σ | 1..* | Reference(eHealth Organization | eHealth Patient | eHealth Practitioner | eHealth RelatedPerson) {r} | Who is agreeing to the policy and exceptions |
actor | ΣI | 1..* | 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) | |
reference | 1..1 | Reference(eHealth Device | Group | eHealth CareTeam | eHealth Organization | eHealth Patient | eHealth Practitioner | eHealth RelatedPerson) {r} | Resource for the actor (or group, by role) | |
action | Σ | 0..* | CodeableConcept | Actions controlled by this consent Binding: Consent Action Codes (example) |
organization | Σ | 0..* | Reference(eHealth Organization) {r} | Custodian of the consent |
source[x] | Σ | 0..1 | Attachment, Identifier, Reference(eHealth Consent | ehealth-documentreference | Contract | eHealth QuestionnaireResponse) {r} | Source from which this consent is taken |
policy | I | 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 | I | 0..1 | uri | Enforcement source for policy |
uri | I | 0..1 | uri | Specific policy covered by this consent |
policyRule | ΣI | 0..1 | uri | Policy that this consents to |
securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible) |
purpose | Σ | 0..* | Coding | Context of activities for which the agreement is made Binding: PurposeOfUse (extensible) |
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this consent |
data | ΣI | 1..* | 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) |
reference | Σ | 1..1 | Reference(eHealth EpisodeOfCare) {r} | The actual data reference |
except | ΣI | 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) |
period | Σ | 0..1 | Period | Timeframe for this exception |
actor | ΣI | 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) | |
reference | 1..1 | Reference(eHealth Device | Group | eHealth CareTeam | eHealth Organization | eHealth Patient | eHealth Practitioner | eHealth RelatedPerson) {r} | Resource for the actor (or group, by role) | |
action | Σ | 0..* | CodeableConcept | Actions controlled by this exception Binding: Consent Action Codes (example) |
securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible) |
purpose | Σ | 0..* | Coding | Context of activities covered by this exception Binding: PurposeOfUse (extensible) |
class | Σ | 0..* | Coding | e.g. Resource Type, Profile, or CDA etc Binding: Consent Content Class (extensible) |
code | Σ | 0..* | Coding | e.g. LOINC or SNOMED CT code, etc in the content Binding: Consent Content Codes (example) |
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this exception |
data | ΣI | 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) |
reference | Σ | 1..1 | Reference(Resource) {r} | The actual data reference |
Documentation for this format |
Path | Name | Conformance | ValueSet |
Consent.language | Common Languages | extensible | Common Languages |
Consent.status | ConsentState | required | ConsentState |
Consent.category | ConsentCategory | required | ConsentCategory |
Consent.category.coding | ConsentCategory | required | ConsentCategory |
Consent.actor.role | SecurityRoleType | extensible | SecurityRoleType (missing link) |
Consent.action | Consent Action Codes | example | Consent Action Codes |
Consent.securityLabel | All Security Labels | extensible | All Security Labels |
Consent.purpose | PurposeOfUse | extensible | PurposeOfUse |
Consent.data.meaning | ConsentDataMeaning | required | ConsentDataMeaning |
Consent.except.type | ConsentExceptType | required | ConsentExceptType |
Consent.except.actor.role | SecurityRoleType | extensible | SecurityRoleType (missing link) |
Consent.except.action | Consent Action Codes | example | Consent Action Codes |
Consent.except.securityLabel | All Security Labels | extensible | All Security Labels |
Consent.except.purpose | PurposeOfUse | extensible | PurposeOfUse |
Consent.except.class | Consent Content Class | extensible | Consent Content Class |
Consent.except.code | Consent Content Codes | example | Consent Content Codes |
Consent.except.data.meaning | ConsentDataMeaning | required | ConsentDataMeaning |
Id | Path | Details | Requirements |
dom-2 | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Consent | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | 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() | |
ppc-1 | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
ele-1 | Consent.actor | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Consent.policy | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Consent.data | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Consent.except | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Consent.except.actor | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Consent.except.data | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |