0.1.2 - ci-build CH

KISIMConsent - Local Development build (v0.1.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: KISIM EPD/EPR ( Experimental )

Official URL: http://fhir.kisimdocs.ch/ig/KisimConsent/StructureDefinition/KisimEPD Version: 0.1.2
Draft as of 2025-08-15 Computable Name: KisimEPD

KISIM specific representation of a Consent for the use of the electronic patient record (EPR) / Elektronisches Patientendossier (EPD)

Comments on the composition

Status:

  • active: EPR available with corresponding decision regarding upload.
  • inactive: EPR is available, but the decision is outdated. Because it has been amended, for example.
  • unknown: No existing EPR.

Category:
FHIR ActCode: IDSCL Information disclosure
Category was taken over from CH Core ERP-Consent.
General category for information transfer.

Provision.code:
FHIR PolicyRuleCodes: ch-epr
Specification that this is the Swiss EPR.

Decision:
If a decision is set, then only deny, as this becomes a permit in the provision and no consent is recorded if the EPD is rejected.
Encounter exclusions are specified in provision.provision.
If no provision.provision is specified, the decision here applies to all encounters of the patient.
If the status is unknown (no EPR available), no decision is set.

Provision.provision.data:
Is only specified if upload restrictions are to apply to a specific encounter, e.g. encounter exclusion.
If several encounters are to be excluded from the upload, several provisions must be appended. One for each affected encounter.
The patient encounter number is specified.

View in KISIM

Teilnahme:
Displayed in the "Patientenregister", in the "Stammdatenregister".

EPD Teilnahme


Encounter exclusion/Fallausschluss:
Displayed in the 'Fallregister' in the 'Stanmmdatenregister'.

EPD Fallausschluss

Examples

Usages:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* KisimCoreConsent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... category SΣ 1..* CodeableConcept Initial classification of consent, used with provision.code to identify consent types.
Binding: ConsentCategoriesVS (required)
... subject SΣ 1..1 Reference(Patient) The patient to whom this consent applies to.
... date SΣ 1..1 date Respresents the date when the entry to the system was made.
... period SΣ 1..1 Period Effective period for this Consent
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
... grantor SΣ 1..1 Reference(Patient | RelatedPerson | Organization) Person who has given or denied consent. Generally either patient or legal representative.
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Either Patient or RelatedPerson.
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string Either Patient ID or RelatedPerson ID.
Example General: 123456
... grantee SΣ 1..1 Reference(Organization) Organization that must follow the instructions of the Consent or is granted rights.
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Organization
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Organization
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string UID of the Organization.
Example General: 123456
.... display SΣC 1..1 string Name of the Organization as defined in the referenced resource.
... manager S 1..1 Reference(HealthcareService) Application that recorded/changed the consent. For instance a CIS or a Patientportal.
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: HealthcareService
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string Name of the Application as defined in the referenced resource.
Example General: 123456
.... display SΣC 1..1 string Name of the Application as defined in the referenced resource.
... controller S 1..1 Reference(Organization) Organization to which the Consent applies.
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Organization
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string UID of the Organization.
Example General: 123456
.... display SΣC 1..1 string Name of the Organization as defined in the referenced resource.
... decision ?!SΣ 0..1 code deny = EPD present | No decision if no EPR exists or status unknown. When changed/withdrawn, the status changes to inactive, but the decision remains the same.
Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
... provision SΣ 1..* BackboneElement Exeptions/Constraints to the base decision.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..* CodeableConcept Additional classification of consent, used with category to identify consent types.
Binding: ConsentProvisionCodesVS (required)
.... provision 0..* BackboneElement Is only specified if restrictions are only to apply to a specific case/encounter, e.g. case exclusion (Fallausschluss). A separate provision.provision must be created for each case/encounter concerned.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... data SΣ 0..* BackboneElement Data controlled by this provision
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... meaning SΣ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Required Pattern: related
...... reference SΣ 1..1 Reference(Encounter) Encounter/Patientenfall for which an exception to the decision is to be made.
....... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
....... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ value SΣC 0..1 string Encounternumber/Patientenfallnummer of the respective Encounter.
Example General: 123456

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0
From the FHIR Standard
Consent.categoryrequiredConsentCategoriesVS
http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS
From this IG
Consent.grantor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.grantor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.grantee.typeextensiblePattern Value: Organization
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.grantee.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.manager.typeextensiblePattern Value: HealthcareService
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.manager.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.controller.typeextensiblePattern Value: Organization
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.controller.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.decisionrequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0
From the FHIR Standard
Consent.provision.coderequiredConsentProvisionCodesVS
http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS
From this IG
Consent.provision.provision.data.meaningrequiredPattern Value: related
http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0
From the FHIR Standard
Consent.provision.provision.data.reference.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorConsentIf 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-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from KisimCoreConsent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* KisimCoreConsent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... status 1..1 code active | inactive | unknown => active for EPR present with corresponding decision, inactive as soon as patient changes/withdraws decision, unknown if no EPR exists.
... category
.... coding
..... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
..... code 0..1 code Symbol in syntax defined by the system
Required Pattern: IDSCL
... grantee 1..1 Reference(Organization) Organization that must follow the instructions of the Consent or is granted rights.
.... type 1..1 uri Organization
Required Pattern: Organization
.... identifier
..... value 0..1 string UID of the Organization.
.... display 1..1 string Name of the Organization as defined in the referenced resource.
... provision
.... code
..... coding
...... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/consentpolicycodes
...... code 0..1 code Symbol in syntax defined by the system
Required Pattern: ch-epr
.... provision 0..* BackboneElement Is only specified if restrictions are only to apply to a specific case/encounter, e.g. case exclusion (Fallausschluss). A separate provision.provision must be created for each case/encounter concerned.
..... data S 0..* BackboneElement Data controlled by this provision
...... meaning S 1..1 code instance | related | dependents | authoredby
Required Pattern: related
...... reference S 1..1 Reference(Encounter) Encounter/Patientenfall for which an exception to the decision is to be made.
....... identifier
........ value S 0..1 string Encounternumber/Patientenfallnummer of the respective Encounter.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* KisimCoreConsent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier for this record (external references)
... status ?!SΣ 1..1 code active | inactive | unknown => active for EPR present with corresponding decision, inactive as soon as patient changes/withdraws decision, unknown if no EPR exists.
Binding: ConsentState (required): Indicates the state of the consent.
... category SΣ 1..* CodeableConcept Initial classification of consent, used with provision.code to identify consent types.
Binding: ConsentCategoriesVS (required)
.... id 0..1 id Unique id for inter-element referencing
.... 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 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
..... version Σ 0..1 string Version of the system - if relevant
..... code ΣC 0..1 code Symbol in syntax defined by the system
Required Pattern: IDSCL
..... display ΣC 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
... subject SΣ 1..1 Reference(Patient) The patient to whom this consent applies to.
... date SΣ 1..1 date Respresents the date when the entry to the system was made.
... period SΣ 1..1 Period Effective period for this Consent
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... grantor SΣ 1..1 Reference(Patient | RelatedPerson | Organization) Person who has given or denied consent. Generally either patient or legal representative.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Either Patient or RelatedPerson.
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string Either Patient ID or RelatedPerson ID.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display ΣC 0..1 string Text alternative for the resource
... grantee SΣ 1..1 Reference(Organization) Organization that must follow the instructions of the Consent or is granted rights.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Organization
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Organization
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string UID of the Organization.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display SΣC 1..1 string Name of the Organization as defined in the referenced resource.
... manager S 1..1 Reference(HealthcareService) Application that recorded/changed the consent. For instance a CIS or a Patientportal.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: HealthcareService
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string Name of the Application as defined in the referenced resource.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display SΣC 1..1 string Name of the Application as defined in the referenced resource.
... controller S 1..1 Reference(Organization) Organization to which the Consent applies.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Organization
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string UID of the Organization.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display SΣC 1..1 string Name of the Organization as defined in the referenced resource.
... sourceAttachment 0..* Attachment Source from which this consent is taken
... sourceReference 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
... regulatoryBasis 0..* CodeableConcept Regulations establishing base Consent
Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
... policyBasis 0..1 BackboneElement Computable version of the backing policy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference(Resource) Reference backing policy resource
.... url 0..1 url URL to a computable backing policy
... policyText 0..* Reference(DocumentReference) Human Readable Policy
... verification Σ 0..* BackboneElement Consent Verified by patient or family
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... verified Σ 1..1 boolean Has been verified
.... verificationType 0..1 CodeableConcept Business case of verification
Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
.... verifiedBy 0..1 Reference(Organization | Practitioner | PractitionerRole) Person conducting verification
.... verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
.... verificationDate 0..* dateTime When consent verified
... decision ?!SΣ 0..1 code deny = EPD present | No decision if no EPR exists or status unknown. When changed/withdrawn, the status changes to inactive, but the decision remains the same.
Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
... provision SΣ 1..* BackboneElement Exeptions/Constraints to the base decision.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period Σ 0..1 Period Timeframe for this provision
.... actor 0..* BackboneElement Who|what controlled by this provision (or group, by role)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role 0..1 CodeableConcept How the actor is involved
Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
..... reference 0..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
.... action Σ 0..* CodeableConcept Actions controlled by this provision
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
.... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose Σ 0..* Coding Context of activities covered by this provision
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.
.... documentType Σ 0..* Coding e.g. Resource Type, Profile, CDA, etc
Binding: ConsentContentClass (preferred): The document type a consent provision covers.
.... resourceType Σ 0..* Coding e.g. Resource Type, Profile, etc
Binding: ResourceType (extensible): The resource types a consent provision covers.
.... code SΣ 1..* CodeableConcept Additional classification of consent, used with category to identify consent types.
Binding: ConsentProvisionCodesVS (required)
..... id 0..1 id Unique id for inter-element referencing
..... 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 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/consentpolicycodes
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Symbol in syntax defined by the system
Required Pattern: ch-epr
...... display ΣC 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
.... dataPeriod Σ 0..1 Period Timeframe for data controlled by this provision
.... data Σ 0..* BackboneElement Data controlled by this provision
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
..... reference Σ 1..1 Reference(Resource) The actual data reference
.... expression 0..1 Expression A computable expression of the consent
.... provision 0..* BackboneElement Is only specified if restrictions are only to apply to a specific case/encounter, e.g. case exclusion (Fallausschluss). A separate provision.provision must be created for each case/encounter concerned.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... period Σ 0..1 Period Timeframe for this provision
..... actor 0..* BackboneElement Who|what controlled by this provision (or group, by role)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... role 0..1 CodeableConcept How the actor is involved
Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
...... reference 0..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
..... action Σ 0..* CodeableConcept Actions controlled by this provision
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
..... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
..... purpose Σ 0..* Coding Context of activities covered by this provision
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.
..... documentType Σ 0..* Coding e.g. Resource Type, Profile, CDA, etc
Binding: ConsentContentClass (preferred): The document type a consent provision covers.
..... resourceType Σ 0..* Coding e.g. Resource Type, Profile, etc
Binding: ResourceType (extensible): The resource types a consent provision covers.
..... code Σ 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
..... dataPeriod Σ 0..1 Period Timeframe for data controlled by this provision
..... data SΣ 0..* BackboneElement Data controlled by this provision
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... meaning SΣ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Required Pattern: related
...... reference SΣ 1..1 Reference(Encounter) Encounter/Patientenfall for which an exception to the decision is to be made.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
....... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
....... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
........ value SΣC 0..1 string Encounternumber/Patientenfallnummer of the respective Encounter.
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... display ΣC 0..1 string Text alternative for the resource
..... expression 0..1 Expression A computable expression of the consent
..... provision 0..* See provision (Consent) Nested Exception Provisions

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0
From the FHIR Standard
Consent.categoryrequiredConsentCategoriesVS
http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS
From this IG
Consent.grantor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.grantor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.grantor.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Consent.grantee.typeextensiblePattern Value: Organization
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.grantee.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.grantee.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Consent.manager.typeextensiblePattern Value: HealthcareService
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.manager.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.manager.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Consent.controller.typeextensiblePattern Value: Organization
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.controller.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.controller.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Consent.regulatoryBasisexampleConsentPolicyRuleCodes
http://hl7.org/fhir/ValueSet/consent-policy
From the FHIR Standard
Consent.verification.verificationTypeexampleConsentVerificationCodes
http://hl7.org/fhir/ValueSet/consent-verification
From the FHIR Standard
Consent.decisionrequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0
From the FHIR Standard
Consent.provision.actor.roleextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
From the FHIR Standard
Consent.provision.actionexampleConsentActionCodes
http://hl7.org/fhir/ValueSet/consent-action
From the FHIR Standard
Consent.provision.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
From the FHIR Standard
Consent.provision.purposeextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.documentTypepreferredConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
From the FHIR Standard
Consent.provision.resourceTypeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.provision.coderequiredConsentProvisionCodesVS
http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS
From this IG
Consent.provision.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0
From the FHIR Standard
Consent.provision.provision.actor.roleextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
From the FHIR Standard
Consent.provision.provision.actionexampleConsentActionCodes
http://hl7.org/fhir/ValueSet/consent-action
From the FHIR Standard
Consent.provision.provision.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
From the FHIR Standard
Consent.provision.provision.purposeextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.provision.documentTypepreferredConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
From the FHIR Standard
Consent.provision.provision.resourceTypeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.provision.provision.codeexampleConsentContentCodes
http://hl7.org/fhir/ValueSet/consent-content-code
From the FHIR Standard
Consent.provision.provision.data.meaningrequiredPattern Value: related
http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0
From the FHIR Standard
Consent.provision.provision.data.reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.provision.provision.data.reference.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.provision.provision.data.reference.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorConsentIf 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-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from KisimCoreConsent

Summary

Must-Support: 4 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* KisimCoreConsent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... category SΣ 1..* CodeableConcept Initial classification of consent, used with provision.code to identify consent types.
Binding: ConsentCategoriesVS (required)
... subject SΣ 1..1 Reference(Patient) The patient to whom this consent applies to.
... date SΣ 1..1 date Respresents the date when the entry to the system was made.
... period SΣ 1..1 Period Effective period for this Consent
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
... grantor SΣ 1..1 Reference(Patient | RelatedPerson | Organization) Person who has given or denied consent. Generally either patient or legal representative.
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Either Patient or RelatedPerson.
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string Either Patient ID or RelatedPerson ID.
Example General: 123456
... grantee SΣ 1..1 Reference(Organization) Organization that must follow the instructions of the Consent or is granted rights.
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Organization
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Organization
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string UID of the Organization.
Example General: 123456
.... display SΣC 1..1 string Name of the Organization as defined in the referenced resource.
... manager S 1..1 Reference(HealthcareService) Application that recorded/changed the consent. For instance a CIS or a Patientportal.
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: HealthcareService
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string Name of the Application as defined in the referenced resource.
Example General: 123456
.... display SΣC 1..1 string Name of the Application as defined in the referenced resource.
... controller S 1..1 Reference(Organization) Organization to which the Consent applies.
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Organization
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string UID of the Organization.
Example General: 123456
.... display SΣC 1..1 string Name of the Organization as defined in the referenced resource.
... decision ?!SΣ 0..1 code deny = EPD present | No decision if no EPR exists or status unknown. When changed/withdrawn, the status changes to inactive, but the decision remains the same.
Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
... provision SΣ 1..* BackboneElement Exeptions/Constraints to the base decision.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..* CodeableConcept Additional classification of consent, used with category to identify consent types.
Binding: ConsentProvisionCodesVS (required)
.... provision 0..* BackboneElement Is only specified if restrictions are only to apply to a specific case/encounter, e.g. case exclusion (Fallausschluss). A separate provision.provision must be created for each case/encounter concerned.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... data SΣ 0..* BackboneElement Data controlled by this provision
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... meaning SΣ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Required Pattern: related
...... reference SΣ 1..1 Reference(Encounter) Encounter/Patientenfall for which an exception to the decision is to be made.
....... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
....... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ value SΣC 0..1 string Encounternumber/Patientenfallnummer of the respective Encounter.
Example General: 123456

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0
From the FHIR Standard
Consent.categoryrequiredConsentCategoriesVS
http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS
From this IG
Consent.grantor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.grantor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.grantee.typeextensiblePattern Value: Organization
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.grantee.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.manager.typeextensiblePattern Value: HealthcareService
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.manager.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.controller.typeextensiblePattern Value: Organization
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.controller.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.decisionrequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0
From the FHIR Standard
Consent.provision.coderequiredConsentProvisionCodesVS
http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS
From this IG
Consent.provision.provision.data.meaningrequiredPattern Value: related
http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0
From the FHIR Standard
Consent.provision.provision.data.reference.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorConsentIf 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-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from KisimCoreConsent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* KisimCoreConsent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... status 1..1 code active | inactive | unknown => active for EPR present with corresponding decision, inactive as soon as patient changes/withdraws decision, unknown if no EPR exists.
... category
.... coding
..... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
..... code 0..1 code Symbol in syntax defined by the system
Required Pattern: IDSCL
... grantee 1..1 Reference(Organization) Organization that must follow the instructions of the Consent or is granted rights.
.... type 1..1 uri Organization
Required Pattern: Organization
.... identifier
..... value 0..1 string UID of the Organization.
.... display 1..1 string Name of the Organization as defined in the referenced resource.
... provision
.... code
..... coding
...... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/consentpolicycodes
...... code 0..1 code Symbol in syntax defined by the system
Required Pattern: ch-epr
.... provision 0..* BackboneElement Is only specified if restrictions are only to apply to a specific case/encounter, e.g. case exclusion (Fallausschluss). A separate provision.provision must be created for each case/encounter concerned.
..... data S 0..* BackboneElement Data controlled by this provision
...... meaning S 1..1 code instance | related | dependents | authoredby
Required Pattern: related
...... reference S 1..1 Reference(Encounter) Encounter/Patientenfall for which an exception to the decision is to be made.
....... identifier
........ value S 0..1 string Encounternumber/Patientenfallnummer of the respective Encounter.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* KisimCoreConsent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier for this record (external references)
... status ?!SΣ 1..1 code active | inactive | unknown => active for EPR present with corresponding decision, inactive as soon as patient changes/withdraws decision, unknown if no EPR exists.
Binding: ConsentState (required): Indicates the state of the consent.
... category SΣ 1..* CodeableConcept Initial classification of consent, used with provision.code to identify consent types.
Binding: ConsentCategoriesVS (required)
.... id 0..1 id Unique id for inter-element referencing
.... 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 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
..... version Σ 0..1 string Version of the system - if relevant
..... code ΣC 0..1 code Symbol in syntax defined by the system
Required Pattern: IDSCL
..... display ΣC 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
... subject SΣ 1..1 Reference(Patient) The patient to whom this consent applies to.
... date SΣ 1..1 date Respresents the date when the entry to the system was made.
... period SΣ 1..1 Period Effective period for this Consent
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... grantor SΣ 1..1 Reference(Patient | RelatedPerson | Organization) Person who has given or denied consent. Generally either patient or legal representative.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Either Patient or RelatedPerson.
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string Either Patient ID or RelatedPerson ID.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display ΣC 0..1 string Text alternative for the resource
... grantee SΣ 1..1 Reference(Organization) Organization that must follow the instructions of the Consent or is granted rights.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Organization
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Organization
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string UID of the Organization.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display SΣC 1..1 string Name of the Organization as defined in the referenced resource.
... manager S 1..1 Reference(HealthcareService) Application that recorded/changed the consent. For instance a CIS or a Patientportal.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: HealthcareService
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string Name of the Application as defined in the referenced resource.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display SΣC 1..1 string Name of the Application as defined in the referenced resource.
... controller S 1..1 Reference(Organization) Organization to which the Consent applies.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type SΣ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Organization
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri urn:oid
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 0..1 string UID of the Organization.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display SΣC 1..1 string Name of the Organization as defined in the referenced resource.
... sourceAttachment 0..* Attachment Source from which this consent is taken
... sourceReference 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
... regulatoryBasis 0..* CodeableConcept Regulations establishing base Consent
Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
... policyBasis 0..1 BackboneElement Computable version of the backing policy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference(Resource) Reference backing policy resource
.... url 0..1 url URL to a computable backing policy
... policyText 0..* Reference(DocumentReference) Human Readable Policy
... verification Σ 0..* BackboneElement Consent Verified by patient or family
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... verified Σ 1..1 boolean Has been verified
.... verificationType 0..1 CodeableConcept Business case of verification
Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
.... verifiedBy 0..1 Reference(Organization | Practitioner | PractitionerRole) Person conducting verification
.... verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
.... verificationDate 0..* dateTime When consent verified
... decision ?!SΣ 0..1 code deny = EPD present | No decision if no EPR exists or status unknown. When changed/withdrawn, the status changes to inactive, but the decision remains the same.
Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
... provision SΣ 1..* BackboneElement Exeptions/Constraints to the base decision.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period Σ 0..1 Period Timeframe for this provision
.... actor 0..* BackboneElement Who|what controlled by this provision (or group, by role)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role 0..1 CodeableConcept How the actor is involved
Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
..... reference 0..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
.... action Σ 0..* CodeableConcept Actions controlled by this provision
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
.... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose Σ 0..* Coding Context of activities covered by this provision
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.
.... documentType Σ 0..* Coding e.g. Resource Type, Profile, CDA, etc
Binding: ConsentContentClass (preferred): The document type a consent provision covers.
.... resourceType Σ 0..* Coding e.g. Resource Type, Profile, etc
Binding: ResourceType (extensible): The resource types a consent provision covers.
.... code SΣ 1..* CodeableConcept Additional classification of consent, used with category to identify consent types.
Binding: ConsentProvisionCodesVS (required)
..... id 0..1 id Unique id for inter-element referencing
..... 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 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/consentpolicycodes
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Symbol in syntax defined by the system
Required Pattern: ch-epr
...... display ΣC 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
.... dataPeriod Σ 0..1 Period Timeframe for data controlled by this provision
.... data Σ 0..* BackboneElement Data controlled by this provision
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
..... reference Σ 1..1 Reference(Resource) The actual data reference
.... expression 0..1 Expression A computable expression of the consent
.... provision 0..* BackboneElement Is only specified if restrictions are only to apply to a specific case/encounter, e.g. case exclusion (Fallausschluss). A separate provision.provision must be created for each case/encounter concerned.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... period Σ 0..1 Period Timeframe for this provision
..... actor 0..* BackboneElement Who|what controlled by this provision (or group, by role)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... role 0..1 CodeableConcept How the actor is involved
Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
...... reference 0..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
..... action Σ 0..* CodeableConcept Actions controlled by this provision
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
..... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
..... purpose Σ 0..* Coding Context of activities covered by this provision
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.
..... documentType Σ 0..* Coding e.g. Resource Type, Profile, CDA, etc
Binding: ConsentContentClass (preferred): The document type a consent provision covers.
..... resourceType Σ 0..* Coding e.g. Resource Type, Profile, etc
Binding: ResourceType (extensible): The resource types a consent provision covers.
..... code Σ 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
..... dataPeriod Σ 0..1 Period Timeframe for data controlled by this provision
..... data SΣ 0..* BackboneElement Data controlled by this provision
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... meaning SΣ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Required Pattern: related
...... reference SΣ 1..1 Reference(Encounter) Encounter/Patientenfall for which an exception to the decision is to be made.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
....... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
....... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
........ value SΣC 0..1 string Encounternumber/Patientenfallnummer of the respective Encounter.
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... display ΣC 0..1 string Text alternative for the resource
..... expression 0..1 Expression A computable expression of the consent
..... provision 0..* See provision (Consent) Nested Exception Provisions

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0
From the FHIR Standard
Consent.categoryrequiredConsentCategoriesVS
http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS
From this IG
Consent.grantor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.grantor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.grantor.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Consent.grantee.typeextensiblePattern Value: Organization
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.grantee.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.grantee.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Consent.manager.typeextensiblePattern Value: HealthcareService
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.manager.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.manager.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Consent.controller.typeextensiblePattern Value: Organization
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.controller.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.controller.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Consent.regulatoryBasisexampleConsentPolicyRuleCodes
http://hl7.org/fhir/ValueSet/consent-policy
From the FHIR Standard
Consent.verification.verificationTypeexampleConsentVerificationCodes
http://hl7.org/fhir/ValueSet/consent-verification
From the FHIR Standard
Consent.decisionrequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0
From the FHIR Standard
Consent.provision.actor.roleextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
From the FHIR Standard
Consent.provision.actionexampleConsentActionCodes
http://hl7.org/fhir/ValueSet/consent-action
From the FHIR Standard
Consent.provision.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
From the FHIR Standard
Consent.provision.purposeextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.documentTypepreferredConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
From the FHIR Standard
Consent.provision.resourceTypeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.provision.coderequiredConsentProvisionCodesVS
http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS
From this IG
Consent.provision.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0
From the FHIR Standard
Consent.provision.provision.actor.roleextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
From the FHIR Standard
Consent.provision.provision.actionexampleConsentActionCodes
http://hl7.org/fhir/ValueSet/consent-action
From the FHIR Standard
Consent.provision.provision.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
From the FHIR Standard
Consent.provision.provision.purposeextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.provision.documentTypepreferredConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
From the FHIR Standard
Consent.provision.provision.resourceTypeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.provision.provision.codeexampleConsentContentCodes
http://hl7.org/fhir/ValueSet/consent-content-code
From the FHIR Standard
Consent.provision.provision.data.meaningrequiredPattern Value: related
http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0
From the FHIR Standard
Consent.provision.provision.data.reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Consent.provision.provision.data.reference.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Consent.provision.provision.data.reference.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorConsentIf 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-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from KisimCoreConsent

Summary

Must-Support: 4 elements

 

Other representations of profile: CSV, Excel, Schematron